feat: add support for PostgreSQL read replicas in OpenFGA configuration #1043
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduced detailed guidance on configuring OpenFGA with PostgreSQL read replicas to enhance performance and scalability. This update includes instructions for setting up primary and secondary datastores, considerations for synchronous vs. asynchronous replication, and best practices for ensuring data consistency and monitoring replication lag. Signed-off-by: Matthis Holleville <matthish29@gmail.com>
4 tasks
|
@aaguiarz FYI |
aaguiarz
approved these changes
Jun 13, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR introduces detailed documentation for configuring PostgreSQL read replicas in OpenFGA to improve performance and scalability.
- Adds a new “PostgreSQL Read Replicas Configuration” section with setup instructions
- Explains synchronous vs. asynchronous replication and consistency controls
- Provides best practices and example PostgreSQL configuration snippets
Comments suppressed due to low confidence (3)
docs/content/getting-started/setup-openfga/configure-openfga.mdx:91
- The documentation references
HIGHER_CONSISTENCYbut the example code usesConsistencyPreference.HigherConsistency. Please align the naming to avoid confusion by updating the text or example to use the same identifier.
`HIGHER_CONSISTENCY`
docs/content/getting-started/setup-openfga/configure-openfga.mdx:130
- The replica configuration enables
hot_standbybut doesn’t explicitly prevent writes on the standby. Consider addingdefault_transaction_read_only = onto ensure the replica remains read-only.
hot_standby = on
docs/content/getting-started/setup-openfga/configure-openfga.mdx:371
- The URL path segment
data_collectionuses an underscore, but the official OpenTelemetry documentation is underdata-collection(with a hyphen). This link will likely break; please revert to the correct hyphenated path.
https://opentelemetry.io/docs/concepts/data_collection/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Introduced detailed guidance on configuring OpenFGA with PostgreSQL read replicas to enhance performance and scalability. This update includes instructions for setting up primary and secondary datastores, considerations for synchronous vs. asynchronous replication, and best practices for ensuring data consistency and monitoring replication lag.
References
openfga/openfga#2479
Review Checklist
main